Support for Terraform Search (.tfquery.hcl) files #2007
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 21a998a.
anubhav-goel
force-pushed
the
feature/tfsearch-TF-26847
branch
from
ea24c6b to
e87b916
Compare
anubhav-goel
changed the title
This was referenced Aug 7, 2025
jpogran-hashi
suggested changes
Aug 19, 2025
| @@ -46,7 +47,7 @@ This allows IntelliSense to remain accurate e.g. when switching branches in VCS | |||
| or when there are any other changes made to these files outside the editor. | |||
|
|
|||
| If the client implements file watcher, it should watch for any changes | |||
| in `**/*.tf`, `**/*.tfvars`, `*.tfstack.hcl`, `**/*.tfstack.hcl` and `**/*.tfstack.hcl` files in the workspace. | |||
| in `**/*.tf`, `**/*.tfvars`, `**.tfstack.hcl`, `**/*.tfcomponent.hcl`, `**/*.tfdeploy.hcl` and `**/*.tfquery.hcl` files in the workspace. | |||
There was a problem hiding this comment.
Suggested change
| in `**/*.tf`, `**/*.tfvars`, `**.tfstack.hcl`, `**/*.tfcomponent.hcl`, `**/*.tfdeploy.hcl` and `**/*.tfquery.hcl` files in the workspace. | |
| in `**/*.tf`, `**/*.tfvars`, `**/*.tfstack.hcl`, `**/*.tfcomponent.hcl`, `**/*.tfdeploy.hcl` and `**/*.tfquery.hcl` files in the workspace. |
| _, err := f.stateStore.JobStore.EnqueueJob(ctx, job.Job{ | ||
| Dir: dir, | ||
| Func: func(ctx context.Context) error { | ||
| return jobs.SchemaSearchValidation(ctx, f.store, f.moduleFeature, f.rootFeature, dir.Path()) |
There was a problem hiding this comment.
Is there a reason you did not implement ReferenceValidation?
| f.logger.Printf("loading module metadata returned error: %s", jobErr) | ||
| } | ||
|
|
||
| // Reference collection jobs will depend on this one, so we move it here in advance |
There was a problem hiding this comment.
In stacks and modules we have a decode block here that resolves component or module calls, so you get autocompletion for those. Is there not something similiar for tfquery files?
| } | ||
|
|
||
| func searchPathContext(record *state.SearchRecord, stateReader CombinedReader) (*decoder.PathContext, error) { | ||
| resolvedVersion := tfschema.ResolveVersion(stateReader.TerraformVersion(record.Path()), record.Meta.CoreRequirements) |
There was a problem hiding this comment.
Do you need to have a job to parse terraform version in search for this to work? Or does this pull this from moduleReader?
| // ParseSearchConfiguration parses the whole Search configuration, | ||
| // i.e. turns bytes of `*.tfquery.hcl` files into AST ([*hcl.File]). | ||
| func ParseSearchConfiguration(ctx context.Context, fs ReadOnlyFS, searchStore *state.SearchStore, searchPath string) error { | ||
| record, err := searchStore.SearchRecordByPath(searchPath) |
There was a problem hiding this comment.
The use of SearchRecordByPath makes me wonder if this should have all been Query, but I guess it's one use case so it being confusing (sounding like "search all records by path" instead of "get SearchRecords by path")
Comment on lines
+41
to
+46
| isMatchingLanguageId := (rpcContext.LanguageID == lsp.Search.String()) | ||
|
|
||
| // Only parse the file that's being changed/opened, unless this is 1st-time parsing | ||
| if record.DiagnosticsState[globalAst.HCLParsingSource] == operation.OpStateLoaded && | ||
| rpcContext.IsDidChangeRequest() && | ||
| isMatchingLanguageId { |
There was a problem hiding this comment.
Suggested change
| isMatchingLanguageId := (rpcContext.LanguageID == lsp.Search.String()) | |
| // Only parse the file that's being changed/opened, unless this is 1st-time parsing | |
| if record.DiagnosticsState[globalAst.HCLParsingSource] == operation.OpStateLoaded && | |
| rpcContext.IsDidChangeRequest() && | |
| isMatchingLanguageId { | |
| // Only parse the file that's being changed/opened, unless this is 1st-time parsing | |
| if record.DiagnosticsState[globalAst.HCLParsingSource] == operation.OpStateLoaded && | |
| rpcContext.IsDidChangeRequest() && | |
| rpcContext.LanguageID == lsp.Search.String() { |
This was only done because stacks has multiple files. I don't think Search has more than one?
Comment on lines
+63
to
+64
| targets := make(reference.Targets, 0) | ||
| targets = append(targets, searchTargets...) |
There was a problem hiding this comment.
Are there "built-in" references to consider like Stacks has?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This provides completion, hover, and diagnostics for Terraform Search files. Adds new language id - terraform-search.
Related PRs:
Demo
Note
Around 2000 lines of code are related to test cases
TODO